Improve README presentation#26
Merged
shaypal5 merged 1 commit intoMay 31, 2026
Merged
Conversation
shaypal5
added a commit
that referenced
this pull request
May 31, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
letter_set.v1output contract.docs/README.mdwith the required creator credits and remove stale wording that said the generation pipeline was not implemented.Validation
python -m ruff check .python -m mypypython -m pytestPYTHONPATH=src python -m hletterscriptgen validate examples/letter_set/writer_example.jsonPYTHONPATH=src python -m hletterscriptgen schema --format jsongit diff --checkMilestone
No milestone assigned. The repository has roadmap milestones for implementation stages, but this PR is documentation/presentability work and does not map cleanly to a specific implementation milestone.